3 * ResourceLoader module for skin stylesheets.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 class ResourceLoaderSkinModule
extends ResourceLoaderFileModule
{
26 * All skins are assumed to be compatible with mobile
28 public $targets = [ 'desktop', 'mobile' ];
31 * @param ResourceLoaderContext $context
34 public function getStyles( ResourceLoaderContext
$context ) {
35 $logo = $this->getLogoData( $this->getConfig() );
36 $styles = parent
::getStyles( $context );
37 $this->normalizeStyles( $styles );
39 $default = !is_array( $logo ) ?
$logo : $logo['1x'];
40 $styles['all'][] = '.mw-wiki-logo { background-image: ' .
41 CSSMin
::buildUrlValue( $default ) .
44 if ( is_array( $logo ) ) {
45 if ( isset( $logo['svg'] ) ) {
46 $styles['all'][] = '.mw-wiki-logo { ' .
47 'background-image: -webkit-linear-gradient(transparent, transparent), ' .
48 CSSMin
::buildUrlValue( $logo['svg'] ) . '; ' .
49 'background-image: linear-gradient(transparent, transparent), ' .
50 CSSMin
::buildUrlValue( $logo['svg'] ) . ';' .
51 'background-size: 135px auto; }';
53 if ( isset( $logo['1.5x'] ) ) {
55 '(-webkit-min-device-pixel-ratio: 1.5), ' .
56 '(min--moz-device-pixel-ratio: 1.5), ' .
57 '(min-resolution: 1.5dppx), ' .
58 '(min-resolution: 144dpi)'
59 ][] = '.mw-wiki-logo { background-image: ' .
60 CSSMin
::buildUrlValue( $logo['1.5x'] ) . ';' .
61 'background-size: 135px auto; }';
63 if ( isset( $logo['2x'] ) ) {
65 '(-webkit-min-device-pixel-ratio: 2), ' .
66 '(min--moz-device-pixel-ratio: 2), ' .
67 '(min-resolution: 2dppx), ' .
68 '(min-resolution: 192dpi)'
69 ][] = '.mw-wiki-logo { background-image: ' .
70 CSSMin
::buildUrlValue( $logo['2x'] ) . ';' .
71 'background-size: 135px auto; }';
80 * @param ResourceLoaderContext $context
83 public function getPreloadLinks( ResourceLoaderContext
$context ) {
84 return $this->getLogoPreloadlinks();
88 * Helper method for getPreloadLinks()
91 private function getLogoPreloadlinks() {
92 $logo = $this->getLogoData( $this->getConfig() );
99 if ( !is_array( $logo ) ) {
100 // No media queries required if we only have one variant
101 $preloadLinks[ $logo ] = [ 'as' => 'image' ];
102 return $preloadLinks;
105 if ( isset( $logo['svg'] ) ) {
106 // No media queries required if we only have a 1x and svg variant
107 // because all preload-capable browsers support SVGs
108 $preloadLinks [ $logo['svg'] ] = [ 'as' => 'image' ];
109 return $preloadLinks;
112 foreach ( $logo as $dppx => $src ) {
113 // Keys are in this format: "1.5x"
114 $dppx = substr( $dppx, 0, -1 );
115 $logosPerDppx[$dppx] = $src;
118 // Because PHP can't have floats as array keys
119 uksort( $logosPerDppx, function ( $a, $b ) {
122 // Sort from smallest to largest (e.g. 1x, 1.5x, 2x)
126 foreach ( $logosPerDppx as $dppx => $src ) {
127 $logos[] = [ 'dppx' => $dppx, 'src' => $src ];
130 $logosCount = count( $logos );
131 // Logic must match ResourceLoaderSkinModule:
132 // - 1x applies to resolution < 1.5dppx
133 // - 1.5x applies to resolution >= 1.5dppx && < 2dppx
134 // - 2x applies to resolution >= 2dppx
135 // Note that min-resolution and max-resolution are both inclusive.
136 for ( $i = 0; $i < $logosCount; $i++
) {
139 // min-resolution is ">=" (larger than or equal to)
140 // "not min-resolution" is essentially "<"
141 $media_query = 'not all and (min-resolution: ' . $logos[ 1 ]['dppx'] . 'dppx)';
142 } elseif ( $i !== $logosCount - 1 ) {
144 // Media query expressions can only apply "not" to the entire expression
145 // (e.g. can't express ">= 1.5 and not >= 2).
146 // Workaround: Use <= 1.9999 in place of < 2.
147 $upper_bound = floatval( $logos[ $i +
1 ]['dppx'] ) - 0.000001;
148 $media_query = '(min-resolution: ' . $logos[ $i ]['dppx'] .
149 'dppx) and (max-resolution: ' . $upper_bound . 'dppx)';
152 $media_query = '(min-resolution: ' . $logos[ $i ]['dppx'] . 'dppx)';
155 $preloadLinks[ $logos[$i]['src'] ] = [ 'as' => 'image', 'media' => $media_query ];
158 return $preloadLinks;
162 * Ensure all media keys use array values.
164 * Normalises arrays returned by the ResourceLoaderFileModule::getStyles() method.
166 * @param array &$styles Associative array, keys are strings (media queries),
167 * values are strings or arrays
169 private function normalizeStyles( &$styles ) {
170 foreach ( $styles as $key => $val ) {
171 if ( !is_array( $val ) ) {
172 $styles[$key] = [ $val ];
179 * @param Config $conf
180 * @return string|array Single url if no variants are defined,
181 * or an array of logo urls keyed by dppx in form "<float>x".
182 * Key "1x" is always defined. Key "svg" may also be defined,
183 * in which case variants other than "1x" are omitted.
185 protected function getLogoData( Config
$conf ) {
186 $logo = $conf->get( 'Logo' );
187 $logoHD = $conf->get( 'LogoHD' );
189 $logo1Url = OutputPage
::transformResourcePath( $conf, $logo );
199 if ( isset( $logoHD['svg'] ) ) {
200 $logoUrls['svg'] = OutputPage
::transformResourcePath(
205 // Only 1.5x and 2x are supported
206 if ( isset( $logoHD['1.5x'] ) ) {
207 $logoUrls['1.5x'] = OutputPage
::transformResourcePath(
212 if ( isset( $logoHD['2x'] ) ) {
213 $logoUrls['2x'] = OutputPage
::transformResourcePath(
224 * @param ResourceLoaderContext $context
227 public function isKnownEmpty( ResourceLoaderContext
$context ) {
228 // Regardless of whether the files are specified, we always
229 // provide mw-wiki-logo styles.
233 public function getDefinitionSummary( ResourceLoaderContext
$context ) {
234 $summary = parent
::getDefinitionSummary( $context );
236 'logo' => $this->getConfig()->get( 'Logo' ),
237 'logoHD' => $this->getConfig()->get( 'LogoHD' ),